home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / text / hyper / agw / agwriter.doc next >
Text File  |  1996-09-07  |  5KB  |  122 lines
  1. --------------------------------------------------------------------------------
  2. Welcome to AGW Documentation
  3. --------------------------------------------------------------------------------
  4.  
  5.                         AmigaGuide Writer (AGW) V1.02
  6.                         =============================
  7.  
  8.  
  9.         'Introduction'
  10.         'Features'
  11.         'Using AmigaGuide Writer'
  12.         'Distribution'
  13.         'Registering'
  14.  
  15.         'Suggestions'
  16.  
  17.         'DISCLAIMER'
  18.  
  19.         AmigaGuide Documentation produced using AmigaGuide Writer (of course)
  20. --------------------------------------------------------------------------------
  21. Introduction to AmigaGuide Writer
  22. --------------------------------------------------------------------------------
  23.  
  24.         AmigaGuide Writer (AGW) is a program that allows you to create 
  25. quickly and easily AmigaGuide format files from a text file.  AGW (currently)
  26. does not allow you to edit the text, rather you create the text in any text 
  27. editor. (I use and recommend SkoEd by me :-) and then import the text into 
  28. AGW as a Node.
  29.  
  30.         Currently AGW supports the following AmigaGuide commands :
  31.  
  32.                 'DATABASE'
  33.                 'WIDTH'
  34.                 'HEIGHT'
  35.                 'WORDWRAP'
  36.                 'NODE'
  37.                 'TITLE'
  38.                 'NEXT'
  39.                 'PREV'
  40.                 'ENDNODE'
  41.                 'TOC'
  42.                 'LINK'
  43.                 'ALINK'
  44.                 'RX'
  45.                 'RXS'
  46.                 'SYSTEM'
  47.  
  48.         More commands will be added in the future.
  49.  
  50.         What AGW is NOT :
  51.  
  52.                 An AmigaGuide viewer
  53.                 A Text Editor
  54.                 Complete (Not yet anyway :-)
  55. --------------------------------------------------------------------------------
  56. AGW Feature List
  57. --------------------------------------------------------------------------------
  58.  
  59.         AGW has the following features :
  60.  
  61.         » Allows Creation of AmigaGuide Files simply and easily
  62.         » Reads/Writes AmigaGuide files
  63.         » Converts AmigaGuide files to Text
  64.         » Simple GUI interface
  65.         » Create/Delete/Modify LINK/ALINK/RX/RXS/SYSTEM commands
  66.         » Modify Node information
  67.         » Modify File information
  68. --------------------------------------------------------------------------------
  69. Using AGW
  70. --------------------------------------------------------------------------------
  71.  
  72.         AGW is designed for Wb2.0 and Wb3.0 systems only (Upgrade to Wb2.0 
  73. you will not regret it)
  74.  
  75.         In order to create an AmigaGuide document you must first create a
  76. text file that contains the information that you wish to present.  It is
  77. generally better if the text is organised in such a way as to make sense if
  78. read from front to back. (for those people who do not have an AmigaGuide
  79. viewer)
  80.  
  81.         1. Copy the text to the Clipboard or save as a file.
  82.  
  83.         2. In AGW Import from the Clipboard or File.  This will create an
  84.            AmigaGuide document with one node.
  85.  
  86.         3. Split the document into several nodes by clicking on the line
  87.            where you want to split the node and selecting the SPLIT gadget.
  88.            A requester will appear asking you to give node information.
  89.            Remember Nodes must have unique names and the first Node must
  90.            be called MAIN.
  91.  
  92.         5. When you have finished spliting up the document go back through
  93.            each section and create links.
  94.  
  95.                 a) Highlight the word to make into a link.
  96.                 b) Select the link type from the cycle gadget.
  97.                 c) Select the CONNECT gadget.
  98.                 d) From the list select the node to connect to.
  99.  
  100.         6. Repeat 5 until finished.
  101.  
  102.         7. Give the database a name using File Info.
  103.  
  104.         8. Select Save/Save As from the menu and you are done.
  105.  
  106.  
  107.         'Menus'
  108.         'Gadgets'
  109.         'Loading AmigaGuide Files'
  110.         'Testing Links'
  111. --------------------------------------------------------------------------------
  112. Gadgets Commands
  113. --------------------------------------------------------------------------------
  114.  
  115.         The following is a list of Gadget commands (from left to right)
  116.  
  117.         Connect   - This gadget allows you to create a new link.  The type
  118.                     of link is dependant upon the Link Type gadget
  119.         Delete    - This gadget will delete the current link
  120.         Modify    - This gadget allows a link to be changed
  121.         Link Type - This cycle gadget sets the type of links you are creating
  122.         <<        - This gadget will go back 1